Release 10.1A: OpenEdge Data Management:
DataServer for ODBC

Preface

This Preface contains the following sections:

Purpose
Audience
Organization
Typographical conventions
Examples of syntax descriptions
OpenEdge messages

Purpose

This manual explains how to use the OpenEdge™ DataServer for ODBC. It provides startup instructions and a brief tutorial that introduces the utilities that support the DataServer. Additionally, it discusses database design and programming issues to consider when creating applications that access the OpenEdge and ODBC database management systems.

Audience

This book is intended for programmers who want to develop OpenEdge applications with the Progress® 4GL that run with ODBC-compliant databases. It assumes a fundamental knowledge of both Progress and ODBC.

Organization

Chapter 1 "Introduction"

Describes the DataServer architecture (components and configurations) and software requirements, and provides guidelines for using the DataServer.

Chapter 2 "Programming Considerations"

Discusses the differences between OpenEdge databases and supported ODBC data sources and the DataServer strategies for resolving these differences. Includes database design issues, application issues, Progress 4GL issues, stored procedures, and DataServer performance enhancement.

Chapter 3 "Configuring the DataServer"

Presents instructions for configuring the DataServer and for creating, maintaining, and deploying a schema holder.

Chapter 4 "Connecting the DataServer"

Presents various methods for starting and for connecting the DataServer and describes connecting a schema holder. In addition, it provides connection guidelines and lists connection failures and OpenEdge responses.

Chapter 5 "The DataServer Tutorial"

Provides an overview of the ODBC demonstration databases and the opportunity to work with the DataServer utilities for maintaining a schema holder. In addition, it describes the Progress-to-ODBC migration utility.

Chapter 6 "Troubleshooting"

Describes common problems and how to work around them, including tuning your environment and ODBC driver problems.

Appendix A, "Upgrading DataServer Applications"

Provides information on how to upgrade from an earlier version of either the DataServer or an ODBC data source.

Appendix B, "Stored Procedure Reference"

Describes the Progress 4GL statements and functions that support running ODBC data-source stored procedures.

Appendix C, "Server Related Command Line Utilities and Startup Parameters"

Describes the utilities you use to configure, manage, start, and stop the DataServer host and client.

Typographical conventions

This manual uses the following typographical conventions:

Convention	Description
Bold	Bold typeface indicates commands or characters the user types, or the names of user interface elements.
Italic	Italic typeface indicates the title of a document, provides emphasis, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS	Small, bold capital letters indicate OpenEdge™ key functions and generic keyboard keys; for example, GET and CTRL.
KEY1-KEY2	A hyphen between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL-X.
KEY1 KEY2	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
Fixed width	A fixed-width font is used in syntax statements, code examples, and for system output and filenames.
Fixed-width italics	Fixed-width italics indicate variables in syntax statements.
Fixed-width bold	Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width	Uppercase words are Progress® 4GL language keywords. Although these always are shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
Period (.) or colon (:)	All statements except DO, FOR, FUNCTION, PROCEDURE, and REPEAT end with a period. DO, FOR, FUNCTION, PROCEDURE, and REPEAT statements can end with either a period or a colon.
[ ]	Large brackets indicate the items within them are optional.
[ ]	Small brackets are part of the Progress 4GL language.
{ }	Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
{ }	Small braces are part of the Progress 4GL language. For example, a called external procedure must use braces when referencing arguments passed by a calling procedure.
|	A vertical bar indicates a choice.
...	Ellipses indicate repetition: you can choose one or more of the preceding items.

Examples of syntax descriptions

In this example, ACCUM is a keyword, and aggregate and expression are variables:

ACCUM aggregate expression

FOR is one of the statements that can end with either a period or a colon, as in this example:

FOR EACH Customer:   DISPLAY Name. END.

In this example, STREAM stream, UNLESS-HIDDEN, and NO-ERROR are optional:

DISPLAY [ STREAM stream ] [ UNLESS-HIDDEN ] [ NO-ERROR ]

In this example, the outer (small) brackets are part of the language, and the inner (large) brackets denote an optional item:

INITIAL [ constant [ , constant ] ]

A called external procedure must use braces when referencing compile-time arguments passed by a calling procedure, as shown in this example:

{ &argument-name }

In this example, EACH, FIRST, and LAST are optional, but you can choose only one of them:

PRESELECT [ EACH | FIRST | LAST ] record-phrase

In this example, you must include two expressions, and optionally you can include more. Multiple expressions are separated by commas:

MAXIMUM ( expression , expression [ , expression ] ... )

In this example, you must specify MESSAGE and at least one expression or SKIP [ (n) ], and any number of additional expression or SKIP [ ( n ) ] is allowed:

MESSAGE { expression | SKIP [ ( n ) ] } ...

In this example, you must specify {include-file, then optionally any number of argument or &argument-name = "argument-value", and then terminate with }:

{ include-file [ argument | &argument-name = "argument-value" ] ... }

Long syntax descriptions split across lines

Some syntax descriptions are too long to fit on one line. When syntax descriptions are split across multiple lines, groups of optional and groups of required items are kept together in the required order.

In this example, WITH is followed by six optional items:

Syntax

WITH [ ACCUM max-length ] [ expression DOWN ] [ CENTERED ] [ n COLUMNS ] [ SIDE-LABELS ] [ STREAM-IO ]

Complex syntax descriptions with both required and optional elements

Some syntax descriptions are too complex to distinguish required and optional elements by bracketing only the optional elements. For such syntax, the descriptions include both braces (for required elements) and brackets (for optional elements).

In this example, ASSIGN requires either one or more field entries or one record. Options available with field or record are grouped with braces and brackets:

Syntax

ASSIGN { { [ FRAME frame ] { field [ = expression ] } [ WHEN expression ] } ... | { record [ EXCEPT field ... ] } }

OpenEdge messages

OpenEdge displays several types of messages to inform you of routine and unusual occurrences:

Execution messages inform you of errors encountered while OpenEdge is running a procedure; for example, if OpenEdge cannot find a record with a specified index field value.
Compile messages inform you of errors found while OpenEdge is reading and analyzing a procedure before running it; for example, if a procedure references a table name that is not defined in the database.
Startup messages inform you of unusual conditions detected while OpenEdge is getting ready to execute; for example, if you entered an invalid startup parameter.

After displaying a message, OpenEdge proceeds in one of several ways:

Continues execution, subject to the error-processing actions that you specify or that are assumed as part of the procedure. This is the most common action taken after execution messages.
Returns to the OpenEdge Procedure Editor, so you can correct an error in a procedure. This is the usual action taken after compiler messages.
Halts processing of a procedure and returns immediately to the Procedure Editor. This does not happen often.
Terminates the current session.

OpenEdge messages end with a message number in parentheses. In this example, the message number is 200:

** Unknown table name table. (200)

If you encounter an error that terminates OpenEdge, note the message number before restarting.

Obtaining more information about OpenEdge messages

On Windows platforms, use OpenEdge online Help to obtain more information about OpenEdge messages. Many OpenEdge tools include the following Help menu options to provide information about messages:

Choose Help Recent Messages to display detailed descriptions of the most recent OpenEdge message and all other messages returned in the current session.
Choose Help Messages and then enter the message number to display a description of a specific OpenEdge message.
In the Procedure Editor, press the HELP key (F1 or CTRL-W).